STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

D.21.1 StructureDefinition: DAF-VitalSigns

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/daf-vitalsigns

Defines constraints and extensions on the Observation resource for use in querying and retrieving Vital Signs information.

This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).

D.21.1.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*Observation
... identifier S1..*Identifier
... status S1..1code
... code S1..1CodeableConceptCoded Responses from C-CDA Vital Sign Results
Binding: C-CDA Vital Sign Result (extensible)
... subject S1..1Reference(DAF-Patient)
... encounter S0..1Reference(DAF-Encounter)
... effective[x] S1..1dateTime, PeriodOften just a dateTime for Vital Signs
... performer S0..1Reference(DAF-Pract | DAF-Patient | DAF-RelatedPerson | DAF-Organization)
... valueQuantity S0..1QuantityVital Sign Value recorded with UCUM
Binding: Common UCUM units (required)
.... value S0..1decimal
.... unit S0..1string
.... system S0..1uriFixed Value: http://unitsofmeasure.org
.... code S0..1codeCoded responses from the common UCUM units for vital signs value set.
... dataAbsentReason S0..1CodeableConcept
... referenceRange S0..1BackboneElement
.... low S0..1SimpleQuantityBinding: Common UCUM units (required)
..... value S0..1decimal
..... unit S0..1string
..... system S0..1uriFixed Value: http://unitsofmeasure.org
..... code S0..1code
.... high S0..1SimpleQuantityBinding: Common UCUM units (required)
..... value S0..1decimal
..... unit S0..1string
..... system S0..1uriFixed Value: http://unitsofmeasure.org
..... code S0..1code
.... meaning S0..1CodeableConcept
.... text S0..1string
... related S0..1BackboneElementUsed when reporting systolic and diastolic blood pressure.
.... type S1..1codeFixed Value: has-component
.... target S1..1Reference(DAF-VitalSigns)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierUnique Id for this particular observation
... status ?! S∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S ∑1..1CodeableConceptCoded Responses from C-CDA Vital Sign Results
Binding: C-CDA Vital Sign Result (extensible)
... subject S ∑1..1Reference(DAF-Patient)Who and/or what this is about
... encounter S0..1Reference(DAF-Encounter)Healthcare event during which this observation is made
... effective[x] S ∑1..1dateTime, PeriodOften just a dateTime for Vital Signs
... issued ∑0..1instantDate/Time this was made available
... performer S ∑0..1Reference(DAF-Pract | DAF-Patient | DAF-RelatedPerson | DAF-Organization)Who is responsible for the observation
... valueQuantity S ∑0..1QuantityVital Sign Value recorded with UCUM
Binding: Common UCUM units (required)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value S ∑0..1decimalNumerical value (with implicit precision)
.... comparator ?! ∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit S ∑0..1stringUnit representation
.... system S ∑I0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S ∑0..1codeCoded responses from the common UCUM units for vital signs value set.
... dataAbsentReason S I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comment 0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example)
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange S I0..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... low S I0..1SimpleQuantityLow Range, if relevant
Binding: Common UCUM units (required)
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value S ∑0..1decimalNumerical value (with implicit precision)
..... unit S ∑0..1stringUnit representation
..... system S ∑I0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S ∑0..1codeCoded form of the unit
.... high S I0..1SimpleQuantityHigh Range, if relevant
Binding: Common UCUM units (required)
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value S ∑0..1decimalNumerical value (with implicit precision)
..... unit S ∑0..1stringUnit representation
..... system S ∑I0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S ∑0..1codeCoded form of the unit
.... meaning S0..1CodeableConceptIndicates the meaning/use of this range of this range
Binding: Observation Reference Range Meaning Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text S0..1stringText based reference range in an observation
... related S ∑0..1BackboneElementUsed when reporting systolic and diastolic blood pressure.
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... type S1..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
Fixed Value: has-component
.... target S1..1Reference(DAF-VitalSigns)Resource that is related to this one
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Unknown reference to #referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

todo

Differential View

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*Observation
... identifier S1..*Identifier
... status S1..1code
... code S1..1CodeableConceptCoded Responses from C-CDA Vital Sign Results
Binding: C-CDA Vital Sign Result (extensible)
... subject S1..1Reference(DAF-Patient)
... encounter S0..1Reference(DAF-Encounter)
... effective[x] S1..1dateTime, PeriodOften just a dateTime for Vital Signs
... performer S0..1Reference(DAF-Pract | DAF-Patient | DAF-RelatedPerson | DAF-Organization)
... valueQuantity S0..1QuantityVital Sign Value recorded with UCUM
Binding: Common UCUM units (required)
.... value S0..1decimal
.... unit S0..1string
.... system S0..1uriFixed Value: http://unitsofmeasure.org
.... code S0..1codeCoded responses from the common UCUM units for vital signs value set.
... dataAbsentReason S0..1CodeableConcept
... referenceRange S0..1BackboneElement
.... low S0..1SimpleQuantityBinding: Common UCUM units (required)
..... value S0..1decimal
..... unit S0..1string
..... system S0..1uriFixed Value: http://unitsofmeasure.org
..... code S0..1code
.... high S0..1SimpleQuantityBinding: Common UCUM units (required)
..... value S0..1decimal
..... unit S0..1string
..... system S0..1uriFixed Value: http://unitsofmeasure.org
..... code S0..1code
.... meaning S0..1CodeableConcept
.... text S0..1string
... related S0..1BackboneElementUsed when reporting systolic and diastolic blood pressure.
.... type S1..1codeFixed Value: has-component
.... target S1..1Reference(DAF-VitalSigns)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierUnique Id for this particular observation
... status ?! S∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S ∑1..1CodeableConceptCoded Responses from C-CDA Vital Sign Results
Binding: C-CDA Vital Sign Result (extensible)
... subject S ∑1..1Reference(DAF-Patient)Who and/or what this is about
... encounter S0..1Reference(DAF-Encounter)Healthcare event during which this observation is made
... effective[x] S ∑1..1dateTime, PeriodOften just a dateTime for Vital Signs
... issued ∑0..1instantDate/Time this was made available
... performer S ∑0..1Reference(DAF-Pract | DAF-Patient | DAF-RelatedPerson | DAF-Organization)Who is responsible for the observation
... valueQuantity S ∑0..1QuantityVital Sign Value recorded with UCUM
Binding: Common UCUM units (required)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value S ∑0..1decimalNumerical value (with implicit precision)
.... comparator ?! ∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit S ∑0..1stringUnit representation
.... system S ∑I0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S ∑0..1codeCoded responses from the common UCUM units for vital signs value set.
... dataAbsentReason S I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comment 0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example)
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange S I0..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... low S I0..1SimpleQuantityLow Range, if relevant
Binding: Common UCUM units (required)
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value S ∑0..1decimalNumerical value (with implicit precision)
..... unit S ∑0..1stringUnit representation
..... system S ∑I0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S ∑0..1codeCoded form of the unit
.... high S I0..1SimpleQuantityHigh Range, if relevant
Binding: Common UCUM units (required)
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value S ∑0..1decimalNumerical value (with implicit precision)
..... unit S ∑0..1stringUnit representation
..... system S ∑I0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S ∑0..1codeCoded form of the unit
.... meaning S0..1CodeableConceptIndicates the meaning/use of this range of this range
Binding: Observation Reference Range Meaning Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text S0..1stringText based reference range in an observation
... related S ∑0..1BackboneElementUsed when reporting systolic and diastolic blood pressure.
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... type S1..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
Fixed Value: has-component
.... target S1..1Reference(DAF-VitalSigns)Resource that is related to this one
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Unknown reference to #referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

D.21.1.2 Terminology Bindings

PathNameConformanceValueSet
Observation.language?extrequiredhttp://tools.ietf.org/html/bcp47
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodesexampleObservation Category Codes
Observation.codeC-CDA Vital Sign Result extensibleC-CDA Vital Sign Result
Observation.valueQuantityCommon UCUM unitsrequiredCommon UCUM units
Observation.valueQuantity.comparatorQuantityComparatorrequiredQuantityComparator
Observation.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes
Observation.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
Observation.methodObservation MethodsexampleObservation Methods
Observation.referenceRange.lowCommon UCUM unitsrequiredCommon UCUM units
Observation.referenceRange.highCommon UCUM unitsrequiredCommon UCUM units
Observation.referenceRange.meaningObservation Reference Range Meaning CodesexampleObservation Reference Range Meaning Codes
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason

D.21.1.3 Constraints

IdPathDetailsRequirements
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))
obs-7ObservationComponent code SHALL not be same as observation code
XPath: not(exists(f:component/f:code)) or count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0
obs-3Observation.referenceRangeMust have at least a low or a high or text
XPath: (exists(f:low) or exists(f:high)or exists(f:text))
qty-3Observation.referenceRange.lowIf a code for the unit is present, the system SHALL also be present
XPath: not(exists(f:code)) or exists(f:system)
sqty-1Observation.referenceRange.lowThe comparator is not used on a SimpleQuantity
XPath: not(exists(f:comparator))
qty-3Observation.referenceRange.highIf a code for the unit is present, the system SHALL also be present
XPath: not(exists(f:code)) or exists(f:system)
sqty-1Observation.referenceRange.highThe comparator is not used on a SimpleQuantity
XPath: not(exists(f:comparator))
.